Skip to content

Allow linking a prebuilt optimized compiler-rt builtins library #143689

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

pmur
Copy link

@pmur pmur commented Jul 9, 2025

Extend the .optimized-compiler-builtins bootstrap option to accept a path to a prebuilt compiler-rt builtins library, and update compiler-builtins to enable optimized builtins without building compiler-rt builtins.

@rustbot
Copy link
Collaborator

rustbot commented Jul 9, 2025

r? @Kobzol

rustbot has assigned @Kobzol.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added A-compiler-builtins Area: compiler-builtins (https://github.com/rust-lang/compiler-builtins) S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) labels Jul 9, 2025
@rustbot
Copy link
Collaborator

rustbot commented Jul 9, 2025

This PR modifies src/bootstrap/src/core/config.

If appropriate, please update CONFIG_CHANGE_HISTORY in src/bootstrap/src/utils/change_tracker.rs.

This PR modifies bootstrap.example.toml.

If appropriate, please update CONFIG_CHANGE_HISTORY in src/bootstrap/src/utils/change_tracker.rs.

compiler-builtins is developed in its own repository. If possible, consider making this change to rust-lang/compiler-builtins instead.

cc @tgross35

@rust-log-analyzer

This comment has been minimized.

@pmur pmur force-pushed the murp/external-rt-optimized-compiler-builtins branch from 27fcb13 to 1ea1789 Compare July 9, 2025 18:29
@Kobzol
Copy link
Member

Kobzol commented Jul 9, 2025

I don't really know much about the optimized compiler-rt builtins. Maybe @tgross35 might know more?

@tgross35 tgross35 self-assigned this Jul 9, 2025
@Mark-Simulacrum
Copy link
Member

Can you say more about how much time this saves? Historically it's been my impression locally that building is basically free, this flag is more about whether it's possible to build (e.g., needs to be off if you're ad-hoc cross compiling). Though maybe I'm remembering wrong?

@pmur
Copy link
Author

pmur commented Jul 10, 2025

Can you say more about how much time this saves? Historically it's been my impression locally that building is basically free, this flag is more about whether it's possible to build (e.g., needs to be off if you're ad-hoc cross compiling). Though maybe I'm remembering wrong?

The goal is to enable optimized compiler-builtins in fedora packaging. There, rust is built using the distro provided llvm and resulting libraries. Some runtime features are absent if optimized compiler-builtins are not used. Notably, outlined aarch64 LSE atomic operations are not available without this support.

@cuviper
Copy link
Member

cuviper commented Jul 10, 2025

Right, it's less about time and more about wanting to use our existing system LLVM packages.

@pmur
Copy link
Author

pmur commented Jul 22, 2025

Ping @tgross35. The intent here is to enable optimized-builtins in Fedora using the system's compiler-rt.builtins library.

Copy link
Contributor

@tgross35 tgross35 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes to compiler-builtins lgtm with a possible rename of the var, assuming you have verified this works locally. Somebody more familiar with bootstrap (@Kobzol?) will need to review the changes there.

// Optionally, link against a prebuilt compiler-rt library to supply
// optimized intrinsics instead of compiling a subset of compiler-rt
// from source.
let link_against_prebuilt_rt = env::var_os("LLVM_BUILTIN_RT_LIB").is_some();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe LLVM_COMPILER_RT_LIB to match RUST_COMPILER_RT_ROOT, and since this is probably linking the entire compiler-rt rather than just builtins. Also I believe the LLVM library is called "builtins" rather than "builtin"

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the case of fedora, compiler-rt builtins is packaged as a distinct library. I plan on linking against it. Looking at build.rs, on some targets (e.x openbsd), is only a broader compiler-rt library available to link against?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Huh, I have no idea. The context is here rust-lang/compiler-builtins#241

My view of compiler-rt was that it's a large library where components may be turned on and off, which I guess may not be accurate. Maybe it's worth a doc comment in this file that we say we link the whole thing but it can be only the builtins portion.

Extend the <target>.optimized-compiler-builtins bootstrap option to accept a
path to a prebuilt compiler-rt builtins library, and update compiler-builtins
to enable optimized builtins without building compiler-rt builtins.
@pmur pmur force-pushed the murp/external-rt-optimized-compiler-builtins branch from 1ea1789 to 8ce8e15 Compare July 24, 2025 16:20
@pmur
Copy link
Author

pmur commented Jul 28, 2025

The changes to compiler-builtins lgtm with a possible rename of the var, assuming you have verified this works locally. Somebody more familiar with bootstrap (@Kobzol?) will need to review the changes there.

I did test builds with the fedora targets (excepting s390x, it lacks a libcompiler-rt.builtins library in rawhide right now). Likewise, I verified the LSE support linked in for aarch64 does work.

Is it a realistic case to consider something trying to link libgcc.a or libcompiler-rt.builtins.a when std already includes a copy of libcompiler-rt.builtins? That case I haven't tested.

Comment on lines +616 to +622
if let Some(dir) = rt_builtins_ext.parent() {
println!("cargo::rustc-link-search=native={}", dir.display());
}
println!(
"cargo::rustc-link-lib=static:+verbatim={}",
rt_builtins_ext.to_str().unwrap()
);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does println!("cargo::rustc-link-arg={}", rt_builtins_ext.to_str().unwrap()) work to replace these by chance? I think passing the exact path to the linker should avoid needing to set both -l and -L.

@tgross35
Copy link
Contributor

tgross35 commented Aug 1, 2025

Is it a realistic case to consider something trying to link libgcc.a or libcompiler-rt.builtins.a when std already includes a copy of libcompiler-rt.builtins? That case I haven't tested.

I think this can happen in niche build setups, but no special handling should be needed; all three libraries make their builtin symbols weak, so conflicts aren't a problem.

@bors
Copy link
Collaborator

bors commented Aug 1, 2025

☔ The latest upstream changes (presumably #144773) made this pull request unmergeable. Please resolve the merge conflicts.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-compiler-builtins Area: compiler-builtins (https://github.com/rust-lang/compiler-builtins) S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants